You are currently viewing the Homey Apps SDK v2 documentation. New apps should use Homey Apps SDK v3 ››

Radio Configuration

A signal-definition consists of two types of properties; signal encoding properties and radio configuration properties. The first part specifies the characteristics of the data encoding of a signal whereas the radio part specifies the required radio configuration to receive the signal. This section discusses the signal encoding properties of the Homey Signal Definitions.

Attribute values

The table below shows the minimum, maximum and default values of the attributes in the signal-definition

Attribute Description Min. Default Max. Type Unit
repetitions Repetitions 1 10 255 Integer -
rxTimeout rxTimeout 0 10 255 Integer Milliseconds
modulation.type Modulation - 'ASK' - String -
modulation.channelSpacing Channel spacing 58000 325000 812000 Integer Hertz
modulation.channelDeviation Channel deviation 5000 25000 50000 Integer Hertz
modulation.baudRate baudRate 1000 12004 200000 Integer Baud (Bd)
433 MHz specific:
carrier Carrier frequency 433000000 433920000 433990000 Integer Hertz
868 MHz specific:
carrier Carrier frequency 868000000 868300000 868990000 Integer Hertz
Infrared specific:
carrier Carrier frequency 30000 38000 45000 Integer Hertz
dutyCycle Duty Cycle of carrier 30 50 70 Integer Percent

Repetitions

The repetitions attribute defines how often the signal gets repeated. This may be useful if there is a poor connection

RxTimeout

Receiver timeout when sending requests to a device. After the data has been sent, the radio switches into receiving mode and waits for rxTimeout milliseconds for the device to respond. The same radio configuration used when sending the data is also used when waiting for the response.

Modulation

The modulation attribute defines the modulation used by the radio to modulate the signal. When no modulation attribute is provided, Homey will use the default configuration.

Type

The type attribute defines the type of radio modulation that is used by the radio. Supported values are ASK, FSK and GFSK

Channel spacing

The channelSpacing attribute defines the filter bandwidth in receive mode. This attribute is only used when rxTimeout is greater then zero.

Channel deviation

The channelDeviation attribute defines the frequency deviation when using FSK or GFSK modulation.

Baudrate

The baudRate attribute defines the symbol changes per second of the specified signal in Baud.

Carrier

The carrier attribute defines the carrier frequency used while sending a signal. Most radio-devices use the 433.92MHz and 868.3MHz as carrier frequencies. There are devices that use deviating carrier frequencies (e.g. Somfy). If no carrier attribute is defined, the default receiving carrier frequency will be used.